Skip to main content

POST Stop and Cut Live Video

Overview


The table below provides key details about the POST method for stoping and cutting Live Video

POST Stop and Cut Live Video
MethodPOST
URL or Endpoint/api/v1/projectId/live-videos/stop-and-cut
HeadersAuthorization
Content Typeapplication/json
ParametersprojectId
Request Bodytitle, videoPublicId, fromMilisecond, toMilisecond, videoVisibilityOptionId

The description of the URL parameter is as follows:

projectId URL Parameter
URL Parameter NameprojectId
MandatoryYes
Typestring
DescriptionUnique Id of the project.

Request Body

{
"videoPublicId": "string",
"dateTimeFrom": "2024-11-13T13:05:31.392Z",
"dateTimeTo": "2024-11-13T13:05:31.392Z",
"fromMilisecond": 0,
"toMilisecond": 0,
"videoVisibilityOptionId": 0
}
tip

For more information about visibility options, please visit the Visibility Options API

Information about the fields that appear on body request are displayed in the table below.

Field NameTypeDescription
videoPublicIdstringUnique identifier for the video.
dateTimeFromstring (ISO 8601 datetime)Start date and time for the video segment in ISO format.
dateTimeTostring (ISO 8601 datetime)End date and time for the video segment in ISO format.
fromMilisecondintegerStarting point in milliseconds from which the video segment begins.
toMilisecondintegerEnding point in milliseconds at which the video segment ends.
videoVisibilityOptionIdintegerSpecifies the visibility option for the video (e.g., public, private).

Response

{
"success": true,
"errors": [],
"messages": [],
"result": {
"videoPublicId": "string"
},
"resultInfo": null,
"statusCode": 200
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field NameTypeDescription
successboolIf the response is successful it will return true. Otherwise will return false.
errorsarray[]Indicates if there was an error.
messagesarray[]Returns the response message from back-end.
videoPublicIdstringReturns public identifier of the video
resultarray[Object]Returns the response object.
resultInfostringReturns extra information about the result.
statusCodeinteger($int32)Returns the HTTP Status Code.

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

  • HTTP Status Code 400: Bad Request

  • HTTP Status Code 401: Unauthorized

  • HTTP Status Code 403: Forbidden

  • HTTP Status Code 404: Result Not Found

  • HTTP Status Code 500: Internal Server Error

  • HTTP Status Code 503: Backend Fetch Failed